/**
 * Copyright (C) 2009 Matteo Merli <mm@merlimat.org>
 * 
 * $Id: ReturnException.java 13 2009-01-04 11:30:49Z matteo.merli $
 * $URL: http://pxl-lang.googlecode.com/svn/trunk/src/main/java/pxl/errors/ReturnException.java $
 * 
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 * 
 *         http://www.apache.org/licenses/LICENSE-2.0
 * 
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package pxl.errors;

import pxl.types.PxlObject;


/** 
 * The ReturnException is only throwed when a 'return' statement
 * occours.
 * 
 */
@SuppressWarnings("serial")
public class ReturnException extends PxlException
{
    private final PxlObject result;

    public static void throwValue( PxlObject result ) {
        throw new ReturnException( result );
    }
    
    private ReturnException( PxlObject result  ) {
        this.result = result;
    }

    public PxlObject getResult() {
        return result;
    }
}
